package com.xiao.swagerdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 项目名称：swager-demo
 * 类 名 称：SwaggerConfiguration
 * 类 描 述：TODO
 * 创建时间：2021/03/21 18:28
 * 创 建 人：XiaoCoder
 */
@Configuration
@EnableSwagger2 //标记项目启动用 Swagger API 接口文档
public class SwaggerConfiguration {
    @Bean
    public Docket createRestApi() {
        //创建 Docket 对象
        return new Docket(DocumentationType.SWAGGER_2) //文档类型，使用Swagger2
                .apiInfo(this.apiInfo()) // 获取 Api 信息
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xiao.swagerdemo.controller"))
                .paths(PathSelectors.any())
                // 构建出 Docket 对象
                .build();
    }

    /**
     * 创建 API 信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试接口文档示例")
                .description("我是一段描述")
                .version("1.0.0") // 版本号
                .contact(new Contact("XiaoCoder", "https://xyq0801.icu", "1343643063@qq.com")) // 联系人
                .build();
    }
}
